home *** CD-ROM | disk | FTP | other *** search
/ CD Ware Multimedia 1995 May / cd Ware (Juegos) Epimundo.iso / DOS / TOOLS / PGMAID.ZIP / PGMAID.DOC < prev    next >
Encoding:
Text File  |  1986-07-30  |  24.4 KB  |  572 lines

  1.  
  2.                                                                 Page [1]
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.                                 Programmer's Aid
  16.  
  17.                                   Version 1.2
  18.  
  19.                              Copyright (c) 1986 by
  20.  
  21.                                  TurboWare and
  22.  
  23.                               J. P. Richmond, Jr.
  24.  
  25.                               All Rights Reserved
  26.  
  27.  
  28.  
  29.  
  30.                          Commercial Usage Without A Site
  31.                          License Agreement is Forbidden
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.                                  TurboWare
  39.                                  P.O. Box 9476
  40.                                  South Charleston, West Virginia
  41.                                                            25309
  42.  
  43.  
  44.                                                                 Page [2]
  45.  
  46.  
  47. OVERVIEW
  48.             Programmer's Aid is a memory resident utility that
  49.             allows you to instantly call up the ASCII character
  50.             set for review.  This is particularly useful when
  51.             you are working with an editor on a program or text
  52.             file that may need to display ASCII graphics
  53.             characters.  If your editor allows you to enter the
  54.             characters using the ALT key plus the corresponding
  55.             sequence of numbers on the numeric keypad you will
  56.             find Programmer's Aid very helpful.  Programmer's
  57.             Aid allows you to specify the "hot" key (the key
  58.             that invokes the program ).  It also detects the
  59.             video adapter board type and responds accordingly in
  60.             black and white for the monochrome adapter and in
  61.             color for the color graphics adapter.  If you are
  62.             using a monochrome monitor with a color graphics
  63.             adapter card there is a startup switch available to
  64.             force Programmer's Aid into the black and white
  65.             mode.  Since there are 256 ASCII characters in the
  66.             PC, Programmer's Aid provides two pages of display
  67.             thus allowing you to see the entire set of
  68.             characters in only two windows.  The program will
  69.             also check the color graphics adapter card to see if
  70.             it is in a mode that is incompatible with the
  71.             program's 80 x 25 screen mode.  If this occurs a
  72.             short warning beep will sound but Programmer's Aid
  73.             will not disturb the screen.  In text mode
  74.             Programmer's Aid will preserve the screen's contents
  75.             at the time it is invoked and leave the screen
  76.             restored as it was when it exits.  Programmer's Aid
  77.             is available on a site license basis and details
  78.             follow in this documentation.
  79.  
  80.  
  81.                                                                 Page [3]
  82.  
  83.  
  84. SYSTEM REQUIREMENTS
  85.  
  86.             Programmer's Aid requires an IBM PC/XT/AT/PCjr or
  87.             very close compatible with a minimum of 256K.
  88.             Programmer's Aid occupies approximately 32k bytes of
  89.             Ram memory when resident.  On systems with 384k and
  90.             up this will hardly be noticed.  On smaller systems
  91.             it may limit the size of applications you can run.
  92.             PCjr's need at least 256k although you may wish to
  93.             experiment if you have 128k.
  94.  
  95.  
  96. STARTUP
  97.             To startup Programmer's Aid just simply type in
  98.             the following at the Dos prompt:
  99.  
  100.                         PGMAID (press the enter key)
  101.                <PCjr owners use the /JR option; see page 4>
  102.  
  103.             PgmAid will automatically check the video adapter
  104.             card and adjust its output to match the current
  105.             state of the video adapter card.  This means that if
  106.             you have a color graphics adapter card and you are
  107.             in color mode, PgmAid will display in color.  If you
  108.             are in monochrome mode however, it will display in
  109.             black and white.  A slight problem may be
  110.             encountered here with systems employing a color
  111.             graphics adapter card and a monochrome monitor.
  112.             The colors that PgmAid uses (even on a monochrome
  113.             monitor) should be acceptable but if not, to improve
  114.             on the readability of the screens; startup PgmAid
  115.             with the /BW switch as follows:
  116.  
  117.                         PGMAID /BW (press the enter key)
  118.  
  119.             This will invoke PgmAid in a default black and white
  120.             mode and it will remain so until you reload it again.
  121.  
  122.             Note: PgmAid can only be started up once after each
  123.             reboot of your system.  This is due to the fact that
  124.             when the program becomes resident in memory it has
  125.             no way to free up its memory and reload at a later
  126.             time.  (Since you might load other memory resident
  127.             tasks after PgmAid, if it were to release this
  128.             memory chaos would result!)  Therefore if you invoke
  129.             the program with the wrong set of startup options,
  130.             it will be necessary for you to reboot your system
  131.             before you can install it once again.  No harm will
  132.             come to your system however if you forget and try to
  133.             reload PgmAid again.  You will just receive a polite
  134.             message telling you that it is already there.
  135.  
  136.  
  137.                                                                 Page [4]
  138.  
  139.  
  140. OPTIONS
  141.             PgmAid has several "switches" available to the user.
  142.             These switches are actually arguments specified in
  143.             the command line at startup time.  The case of the
  144.             text specifing the switch does not matter; upper or
  145.             lower case is accepted equally well.  Spelling of the
  146.             switch names is critical however.  Switches may be
  147.             placed after the program name in any order.  You do
  148. /BW         not have to specify all the switches.  We have already
  149.             mentioned one of them; the /BW switch.  As mentioned
  150.             earlier, color is the default mode when the color
  151.             adapter card is present and use of the /BW switch
  152.             tells PgmAid to force black and white mode.  Four
  153.             other switches are available as well.  They are:
  154.  
  155.                         /BLINK
  156.                         /JR
  157.                         /KEY=
  158.                         /X
  159.  
  160. /BLINK      The /BLINK switch is for those users who prefer that
  161.             the message explaining how to exit PgmAid be a
  162.             blinking message.  Since some users find this to be
  163.             objectionable the default option is for non-blinking
  164.             messages with the option to override this.
  165.  
  166. /X          The /X switch provides the user with an exploding
  167.             window similar to those found in some other computer
  168.             systems.  Like the /BLINK switch this is purely a
  169.             matter of aesthetics.  Try it, you may like it.
  170.             Junior users, since your machine runs slower than a
  171.             PC you may find this feature to be too slow for your
  172.             liking.  If enough PCjr owners register and
  173.             ask for it I will custom speed up this feature for
  174.             the Junior.
  175.  
  176. /JR         The /JR switch tells PgmAid that you are running it
  177.             on a PCjr.  If you get the message:
  178.  
  179.             "NO FREE USER INTERRUPTS AVAILABLE"
  180.  
  181.             It may be because you are running PgmAid on a PCjr without
  182.             the /JR switch or you are trying to run it on a PC or
  183.             compatible WITH the /JR switch.  The third reason this
  184.             message may appear is that some other piece(s) of software
  185.             has tied up the user interrupts and none are free.  See the
  186.             further discussion of this under MISC on page 7.
  187.  
  188.  
  189.  
  190.                                                                 Page [5]
  191.  
  192.  
  193. OPTIONS (Cont'd.)
  194.  
  195. /KEY        The /KEY switch is one of the most useful switches.
  196.             It allows you to change the key stroke sequence used
  197.             to invoke PgmAid.  As supplied to you, PgmAid's default
  198.             key stroke sequence is Alt 9 (NOT the 9 on the numeric
  199.             keypad).  To execute PgmAid, load it into memory as
  200.             indicated earlier with whatever switches you may deem
  201.             necessary.  For example to load PgmAid in black and
  202.             white mode with an exploding window the Dos command line
  203.             would read:
  204.  
  205.                         PGMAID /BW /X  (press the enter key)
  206.  
  207.             After this is done, hold down the Alternate key
  208.             <ALT> and depress the 9 key at the top of the
  209.             keyboard.  The opening logo screen for PgmAid will
  210.             appear.  To continue on press the letter C as
  211.             indicated on the screen.  Note: this notice will
  212.             only appear the first time after you have loaded
  213.             PgmAid.  (If you decide to become a registered user
  214.             of PgmAid I will send you a switch that will bypass
  215.             this screen.  This is handy for installing PgmAid in
  216.             your Autoexec.Bat file.) If you choose to change the
  217.             keystroke sequence you may do so by use of the /KEY=
  218.             switch.  For example let's say that I choose to use
  219.             the HOME key to pop PgmAid up and down (not a
  220.             particularly good choice but ok for an example).
  221.             The keyboard scan code for the HOME key is 71
  222.             (decimal).  The format of the /KEY switch is:
  223.  
  224.                         /KEY=xxx ( where xxx is the scan code of
  225.                                   the desired key stroke in DECIMAL)
  226.  
  227.             So in the case of my example I would enter at the
  228.             Dos prompt:
  229.                         PGMAID /KEY=71 (press the enter key)
  230.  
  231.             At this point you will get a message indicating that
  232.             PgmAid may be invoked with the selected key stroke
  233.             sequence.  In other words pressing HOME now causes
  234.             PgmAid to pop up on the screen and exit as well.
  235.             Please note that this version of PgmAid works with
  236.             keyboard scan codes and extended keyboard scan
  237.             codes.  Alt 9 is an extended keyboard scan code of
  238.             128 decimal.  It is very important that you specify
  239.             the scan code in DECIMAL as PgmAid does not
  240.             understand Hexadecimal yet.
  241.  
  242.  
  243.                                                                 Page [6]
  244.  
  245.  
  246. SPECIAL SYMBOLS
  247.  
  248.             The following special codes are displayed in place of
  249.             characters that do not show up on the video monitor:
  250.  
  251.                         NUL = The null character
  252.                         BEL = The code to ring the bell
  253.                         BS  = Back space
  254.                         TAB = Tabulator
  255.                         LF  = Line feed
  256.                         HM  = Home
  257.                         FF  = Form feed
  258.                         CR  = Carriage return
  259.                         ESC = Escape
  260.                         RT  = Right
  261.                         LF  = Left
  262.                         UP  = Up
  263.                         DW  = Down
  264.  
  265.  
  266.  
  267.                                                                 Page [7]
  268.  
  269.  
  270. MISC.
  271.             PgmAid detects the current mode of the color graphics
  272.             adapter and if it is in a graphics or 40 column mode
  273.             it will give you a short warning beep each time you
  274.             attempt to invoke it. Sorry, but there just isn't
  275.             enough room in 40 column mode to show all the codes
  276.             on two pages.  Also, if PgmAid popped up in the middle
  277.             of your graphics screen it would wipe out the screen
  278.             contents.  This may be solved in a future edition of
  279.             PgmAid.
  280.  
  281.             There are no known bugs in PgmAid.  If you find one
  282.             please write to TurboWare and describe the bug with
  283.             as much detailed information as possible such as:
  284.  
  285.                 Type of system you are using
  286.                 How much memory you have
  287.                 Type of video adapter card and monitor you are using
  288.                 What program you were "in" when you popped up PgmAid
  289.                 Any program counter "PC=" dumps that may have appeared
  290.                 Any other memory resident programs (TSR's) you may have
  291.                 loaded concurrent with PgmAid.
  292.  
  293.             Another factor you should be aware of is that PgmAid
  294.             uses the User Bios Communication Area address
  295.             0000:04FC through 0000:04FF.  Most programs do not
  296.             use this area.  If however you get the message that
  297.             PgmAid could not load and it is the first time you
  298.             have attempted to load it, then it is likely that
  299.             these bytes in memory are already in use by another
  300.             application.  The message looks like this:
  301.  
  302.              BIOS USER COMMUNICATIONS AREA IN USE BY ANOTHER PROGRAM
  303.  
  304.             One way to locate the offending program is to load
  305.             your programs one at a time attempting to load
  306.             PgmAid after each one until PgmAid will no longer
  307.             load.  Of course you have to reboot after each
  308.             attempt so this is quite a lengthy process.  A
  309.             shotgun approach of eliminating 3 or 4 programs at a
  310.             time may be more useful and a lot quicker.  Also, if
  311.             you are adept at using Debug, the easiest way to
  312.             detect when these bytes come into use is to just
  313.             <D>ump them out using debug.  The Bios User
  314.             Communications Area bytes are at 0000:04FC through
  315.             0000:04FF and the User interrupts are interrupts hex
  316.             60 through hex 67 (Memory locations 0000:0180
  317.             through 0000:019F.  Some of the memory resident
  318.             scheme will be modified in the next release of
  319.             PgmAid and this will cease to be a problem.
  320.  
  321.  
  322.                                                                 Page [8]
  323.  
  324.  
  325. WARRANTY
  326.             Programmer's Aid, herein referred to as PGMAID, is
  327.             supplied on an "AS IS" basis with no warranties
  328.             express or implied including any warranties of
  329.             MERCHANTABILITY, and fitness for the purpose
  330.             intended.  In no event will the author or TurboWare
  331.             be liable to the user of PGMAID for any damages,
  332.             including any loss of profits either real or
  333.             anticipatory, lost savings or other incidental or
  334.             consequential damages arising out of the use of this
  335.             program or inability of use of same, or for any
  336.             claim by another party.
  337.  
  338.                           TurboWare
  339.                           P.O. Box 9476
  340.                           South Charleston, West Virginia
  341.                                                     25309
  342.  
  343.  
  344.  
  345.  
  346.                                                                 Page [9]
  347.  
  348.  
  349. THE USER-SUPPORTED SOFTWARE CONCEPT
  350.  
  351.             Programmer's Aid is distributed on a User-Supported Software
  352.             basis and you are encouraged to copy and share this program
  353.             with your friends.  If you find this program to be of
  354.             benefit to you please consider becoming a registered user
  355.             of PgmAid by sending your $10. contribution to :
  356.  
  357.                                TurboWare
  358.                                P.O. Box 9476
  359.                                South Charleston, West Virginia
  360.                                                         25309
  361.  
  362.             This will entitle you to free notification of other TurboWare
  363.             products as they become available as well as notification
  364.             of additional upgraded versions of Programmer's Aid.
  365.  
  366.             CORPORATE USERS
  367.  
  368.             This program is not available for commercial usage without
  369.             first site licensing the program.  The price of the program
  370.             is cheap when compared to commercial software of equivalent
  371.             quality and discounts are allowed for multiple copies at a
  372.             single company site.  Write for details.
  373.  
  374.  
  375. THE FUTURE
  376.             Ninety percent of what lies ahead is already in your hands
  377.             when you have a copy of PgmAid.  The resident engine of the
  378.             program can be used for a variety of resident Help utilities.
  379.             A customizable form that can work with Ascii files straight
  380.             off the disk is in the works.  It will allow you to design
  381.             your own popup forms and help guides.  Write to TurboWare
  382.             with any suggestions you may have for improvements and
  383.             modifications.
  384.  
  385. NOTE:
  386.             PgmAid is written entirely in "Turbo Pascal".
  387.  
  388.             "Turbo Pascal" is a product of Borland International
  389.             of Scotts Valley, California.  TurboWare is not affiliated
  390.             with Borland International and the products of TurboWare
  391.             are not connected with Borland International nor any of
  392.             their agencies.
  393.  
  394.             IBM PC/XT/AT/PCjr are products of
  395.             International Business Machines Corporation of
  396.             Boca Raton, Florida.
  397.  
  398.                                                                 Page [10]
  399.  
  400.  
  401.           Programmer's Aid 1.2 Registration/Invoice Form #060853
  402.  
  403.  
  404.                                                     Date:_______________
  405.  
  406.                Name: ___________________________________
  407.  
  408.  
  409.                Company: ________________________________
  410.  
  411.  
  412.                Mail Stop: ______________________________
  413.  
  414.  
  415.                Address: ________________________________
  416.  
  417.  
  418.                City: __________________________________ State: ____________
  419.  
  420.  
  421.                Zip: ______________
  422.  
  423.  
  424.      Quantity    Program Description            Price each        Total
  425.      --------    -------------------            ----------       ------
  426.         1        Programmer's Aid                 $10.00         $10.00
  427.  
  428.  
  429. Please forward payment and make check payable to:
  430.  
  431.                         TurboWare
  432.                         P.O. Box 9476
  433.                         So. Charleston, WV 25309
  434.  
  435.  
  436.  
  437. NEW FEATURES OF VERSION 1.1
  438.  
  439.             Several modifications have been made to the original version
  440.             1.0 of PgmAid and the revised version is known as 1.1
  441.             Several users have indicated that they find the fact that
  442.             PgmAid always pops up on Page 1 (and in hexadecimal) each time
  443.             you invoke it to be objectionable.  Therefore version 1.1
  444.             now pops up on whatever page you left it on when you popped
  445.             it off.  In addition if you were viewing the Ascii codes in
  446.             decimal when you popped it off, it will continue to display
  447.             the codes in decimal when you pop it back up again.  The same
  448.             is true if you are using it in hex mode.  Therefore it is
  449.             no longer necessary to always change pages and Ascii code
  450.             display base when you pop up PgmAid.
  451.  
  452.             Three new switches have been added to accommodate users with
  453.             color monitors who may prefer to select their own colors.
  454. /FG=        The /FG switch is used to set the ForeGround text color.
  455. /BG=        The /BG switch is used to set the BackGround text color.
  456. /BD=        The /BD switch is used to select the border color of the box.
  457. /DC=        The /DC switch is used to select the color of the decimal
  458.             presentations of the Ascii codes.
  459. /HX=        The /HX switch is used to select the color of the hexadecimal
  460.             presentations of the Ascii codes.
  461.  
  462.             If these switches are omitted the default colors will be
  463.             used if appropriate.  If however, you specify one or more of
  464.             these switches, the color you select will act as an override
  465.             of the default colors.  Some color combinations may be quite
  466.             difficult to read.  To use these switches specify them
  467.             in the command line as follows:
  468.  
  469.             Example:       /FG=3 /HX=9
  470.  
  471.             In this example the foreground text color will be set to
  472.             Cyan and the Hexadecimal numbers will be displayed in light blue.
  473.  
  474.             Here is a table of the colors and their associated
  475.             numbers:
  476.  
  477.                         Number          Color
  478.                         ------          -----
  479.                          000            Black
  480.                          001            Blue
  481.                          002            Green
  482.                          003            Cyan
  483.                          004            Red
  484.                          005            Magenta
  485.                          006            Brown (yellow on some monitors)
  486.                          007            Light Gray
  487.                          008            Dark Gray
  488.                          009            Light Blue
  489.                          010            Light Green
  490.                          011            Light Cyan
  491.                          012            Light Red
  492.                          013            Light Magenta
  493.                          014            Bright Yellow
  494.                          015            White
  495.  
  496.  
  497.  
  498.  
  499. NEW FEATURES OF VERSION 1.2
  500.  
  501.             Version 1.2 has a few minor bugs fixed in it that may have
  502.             caused problems to users of Version 1.1 and earlier versions
  503.             of PgmAid.  In addition, several users are now using TSR
  504.             (Terminate and Stay Resident) control programs to release
  505.             TSR programs such as PgmAid from memory.  As mentioned earlier
  506.             PgmAid was never designed to deallocate its memory once it had
  507.             been loaded.  The reason for this lies in the fact that if the
  508.             user is not careful to preserve the order in which TSR's are
  509.             loaded and unloaded a system crash is most likely to occur.
  510.             TSR control programs remove PgmAid from memory but fail to
  511.             reset the Bios User Communications Area for future usage.  To
  512.             accomodate users who wish to load and unload PgmAid using one
  513.             of the public domain or commercial TSR control programs a
  514.             second program called PgmAidRL.Com has been added to the
  515.             package that will take care of releasing the Bios User
  516.             Communications Area after PgmAid has been unloaded from memory.
  517.             This will allow the user to reload PgmAid at a later time.
  518.             WARNING: If you are not releasing PgmAid from memory with
  519.             a TSR control program but you are running PgmAidRL and then
  520.             reloading PgmAid you will eventually cause a system crash.
  521.             This is because PgmAidRL defeats the memory resident interlock
  522.             in PgmAid and allows multiple copies of the program to be
  523.             loaded into memory.  Do not load multiple copies of PgmAid.
  524.             A normal application sequence for loading and unloading PgmAid
  525.             would be:
  526.  
  527.                 1. Preserve the system interrupts and memory pointers
  528.                    with your TSR control program.
  529.                 2. Load PgmAid
  530.                       .
  531.                       .
  532.                       .
  533.                    (some time later)
  534.                 3. Remove PgmAid from memory with the TSR control program.
  535.                 4. Run PgmAidRL
  536.  
  537.             After these steps are completed you will be able to load
  538.             PgmAid once again with no ill effects.  As mentioned earlier
  539.             this modification was initiated for users who are well versed
  540.             in TSR's and how to control them.  User's unfamiliar with this
  541.             topic may wish to avoid using PgmAidRL.
  542.  
  543.  
  544.  
  545. ****        A pop-up areacode finder is in the works.  Register your copy
  546. Note        of PgmAid and be one of the first to receive notice when the
  547. ****        pop-up areacode finder is ready!
  548.  
  549.  
  550.  
  551.  
  552.          ------------------------------------------------------------
  553.  
  554.                    This disk copy provided as a service of
  555.  
  556.                         The Public (Software) Library
  557.  
  558.                            the software library of
  559.                      The Houston Area League of PC Users
  560.  
  561.  
  562.          For a copy of the latest monthly software library newsletter
  563.           and a list of the 600+ disks in the library, call or write
  564.  
  565.                         The Public (Software) Library
  566.                                 P.O.Box 35705
  567.                            Houston, TX 77235-5705
  568.                                (713) 721-6104
  569.  
  570.             Newsletter subscriptions are available for $12 a year.
  571.  
  572.